Vcenter NamespaceManagement LoadBalancers ConfigSpec

The Vcenter NamespaceManagement LoadBalancers ConfigSpec encapsulates load balancer configuration on vSphere Namespaces.

This schema was added in vSphere API 7.0.1.0.

JSON Example

{
    "id": "string",
    "address_ranges": [
        {
            "address": "string",
            "count": 0
        }
    ],
    "provider": "string",
    "ha_proxy_config_create_spec": {
        "servers": [
            {
                "host": "string",
                "port": 0
            }
        ],
        "username": "string",
        "password": "string",
        "certificate_authority_chain": "string"
    },
    "avi_config_create_spec": {
        "server": {
            "host": "string",
            "port": 0
        },
        "username": "string",
        "password": "string",
        "certificate_authority_chain": "string",
        "cloud_name": "string"
    }
}

string

Required

An identifier that identifies a load balancer and can be used to query or configure load balancer properties via these resources. The identifier has DNS_LABEL restrictions as specified in . This must be an alphanumeric (a-z and 0-9) string, with a maximum length of 63 characters and with the '-' character allowed anywhere except the first or last character. This name is unique across all Namespaces in this vCenter server.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.LoadBalancerConfig.

array of Vcenter NamespaceManagement IPRange

address_ranges

Required

List of address ranges that will be used to derive frontend IP addresses for L4 virtual servers. This field is ignored in case of Avi load balancer provider. In case of HA_PROXY load balancer provider, at least one range must be provided.

This property was added in vSphere API 7.0.1.0.

string

provider

Required

The Vcenter NamespaceManagement LoadBalancers ConfigSpec.provider selects a provider from the list of available providers to be used with vSphere Namespaces.

For more information see: Vcenter NamespaceManagement LoadBalancers Provider.

This property was added in vSphere API 7.0.1.0.

ha_proxy_config_create_spec

Optional

This property is deprecated as of vSphere API 9.0.0.0. Instead, use Vcenter NamespaceManagement Supervisors Networks Edges FoundationLoadBalancerCreateSpec with provider Vcenter NamespaceManagement Networks Edges EdgeProvider.VSPHERE_FOUNDATION.

The Vcenter NamespaceManagement LoadBalancers HAProxyConfigCreateSpec is a conditional configuration made available upon selecting the HA_PROXY load balancer provider. It is used to configure the load balancer at run time.

This property was added in vSphere API 7.0.1.0.

This property is optional and it is only relevant when the value of provider is Vcenter NamespaceManagement LoadBalancers Provider.HA_PROXY.

avi_config_create_spec

Optional

The Vcenter NamespaceManagement LoadBalancers AviConfigCreateSpec is a conditional configuration made available upon selecting the Avi load balancer provider. It is used to configure the load balancer at run time.

This property was added in vSphere API 7.0.2.0.

This property is optional and it is only relevant when the value of provider is Vcenter NamespaceManagement LoadBalancers Provider.AVI.